Corrected spelling (and casing) of error messages #259
Conversation
| } | ||
| catch (Exception e) | ||
| { | ||
| Providers.Log.Logger()?.ReportError("DevHomeRepository", "Could not clone the repository", e); | ||
| return new ProviderOperationResult(ProviderOperationStatus.Failure, e, "Something happened when cloning the repo", "something happened when cloning the repo"); | ||
| return new ProviderOperationResult(ProviderOperationStatus.Failure, e, "Something happened when cloning the repo", "Something happened when cloning the repo"); |
There was a problem hiding this comment.
I know this is a bit nitpicky, but the entire PR/issue is basically a nitpick, so I think it's warranted. If we're going to fix this sort of issue, we should make whatever is touched as correct as possible, so we don't have to fix it again later.
Two issues I see here:
- Use of abbreviations. The abbreviation "repo" is used instead of "repository. Abbreviations and slang are to be avoided. Yes, I know this is all over the code, but if going to change something make it right as we go.
- All the error messages touched in this PR are not complete sentences. Namely just add a period at the end.
https://learn.microsoft.com/en-us/windows/win32/debug/error-message-guidelines
There was a problem hiding this comment.
Thanks, I'll make these corrections.
BTW: I agree that this PR is a nitpick, But I actually did spent several minutes trying to figure out / web searching what "LitGit2" meant in the error dialogue I received before I realized it was a typo (I know, not my brightest moment) - hence the PR.
There was a problem hiding this comment.
Updated the PR. I checked all messages for spelling errors, punctuation, abbreviations and made a few small changes to improve clarity.
* Corrected spelling (and casing) of error messages * Additional corrections to exception messages --------- Co-authored-by: Kristen Schau <[email protected]>
Summary of the pull request
Minor changes to exception messages, solving a typo and incorrect casing
References and relevant issues
#258
Detailed description of the pull request
Maybe the Libgit2-exception should be rephrased entirely to be more helpful for end users, but that's beyond the aim of this small PR.
Validation steps performed
PR checklist